c16x12r.h File Reference

This file contains API for 16x12 R Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures
struct	c16x12r_t
	16x12 R Click context object. More...
struct	c16x12r_cfg_t
	16x12 R Click configuration object. More...

Macros
#define	C16X12R_REG_PAGE_SELECT   0xFD
	16x12 R register list 1.
#define	C16X12R_REG_PAGE_LOCK   0xFE
#define	C16X12R_REG_INT_MASK   0xF0
#define	C16X12R_REG_INT_STATUS   0xF1
#define	C16X12R_PAGE_REG_LED_ON_OFF   0x0000
	16x12 R register list 2.
#define	C16X12R_PAGE_REG_LED_OPEN   0x0018
#define	C16X12R_PAGE_REG_LED_SHORT   0x0030
#define	C16X12R_PAGE_REG_PWM   0x0100
#define	C16X12R_PAGE_REG_MODE   0x0200
#define	C16X12R_PAGE_REG_CONFIG   0x0300
#define	C16X12R_PAGE_REG_GLOBAL_CURRENT_CTRL   0x0301
#define	C16X12R_PAGE_REG_BREATH_ABM1_CTRL1   0x0302
#define	C16X12R_PAGE_REG_BREATH_ABM1_CTRL2   0x0303
#define	C16X12R_PAGE_REG_BREATH_ABM1_CTRL3   0x0304
#define	C16X12R_PAGE_REG_BREATH_ABM1_CTRL4   0x0305
#define	C16X12R_PAGE_REG_BREATH_ABM2_CTRL1   0x0306
#define	C16X12R_PAGE_REG_BREATH_ABM2_CTRL2   0x0307
#define	C16X12R_PAGE_REG_BREATH_ABM2_CTRL3   0x0308
#define	C16X12R_PAGE_REG_BREATH_ABM2_CTRL4   0x0309
#define	C16X12R_PAGE_REG_BREATH_ABM3_CTRL1   0x030A
#define	C16X12R_PAGE_REG_BREATH_ABM3_CTRL2   0x030B
#define	C16X12R_PAGE_REG_BREATH_ABM3_CTRL3   0x030C
#define	C16X12R_PAGE_REG_BREATH_ABM3_CTRL4   0x030D
#define	C16X12R_PAGE_REG_TIME_UPDATE   0x030E
#define	C16X12R_PAGE_REG_SWY_PULLUP_SELECT   0x030F
#define	C16X12R_PAGE_REG_CSX_PULLDOWN_SELECT   0x0310
#define	C16X12R_PAGE_REG_RESET   0x0311
#define	C16X12R_PAGE_SELECT_0   0x00
	16x12 R page select setting.
#define	C16X12R_PAGE_SELECT_1   0x01
#define	C16X12R_PAGE_SELECT_2   0x02
#define	C16X12R_PAGE_SELECT_3   0x03
#define	C16X12R_PAGE_LOCK   0x00
	16x12 R page lock setting.
#define	C16X12R_PAGE_UNLOCK   0xC5
#define	C16X12R_MODE_PWM   0x00
	16x12 R LED mode setting.
#define	C16X12R_MODE_ABM1   0x01
#define	C16X12R_MODE_ABM2   0x02
#define	C16X12R_MODE_ABM3   0x03
#define	C16X12R_CONFIG_SYNC_HIGH_Z   0x00
	16x12 R config page register setting.
#define	C16X12R_CONFIG_SYNC_MASTER   0x40
#define	C16X12R_CONFIG_SYNC_SLAVE   0x80
#define	C16X12R_CONFIG_SYNC_MASK   0xC0
#define	C16X12R_CONFIG_OSD_DIS   0x00
#define	C16X12R_CONFIG_OSD_EN   0x04
#define	C16X12R_CONFIG_OSD_MASK   0x04
#define	C16X12R_CONFIG_B_EN_PWM   0x00
#define	C16X12R_CONFIG_B_EN_ABM   0x02
#define	C16X12R_CONFIG_B_EN_MASK   0x02
#define	C16X12R_CONFIG_SSD_SHUTDOWN   0x00
#define	C16X12R_CONFIG_SSD_NORMAL   0x01
#define	C16X12R_CONFIG_SSD_MASK   0x01
#define	C16X12R_CURRENT_MIN   0x00
	16x12 R global current ctrl page register setting.
#define	C16X12R_CURRENT_DEFAULT   0xA0
#define	C16X12R_CURRENT_MAX   0xFF
#define	C16X12R_PWM_DUTY_MIN   0x00
	16x12 R PWM page register setting.
#define	C16X12R_PWM_DUTY_DEFAULT   0xA0
#define	C16X12R_PWM_DUTY_MAX   0xFF
#define	C16X12R_LED_STATE_OFF   0
	16x12 R LED state setting.
#define	C16X12R_LED_STATE_ON   1
#define	C16X12R_NUM_LEDS   192
	16x12 R LED selection setting.
#define	C16X12R_NUM_ROWS   16
#define	C16X12R_NUM_COLUMNS   12
#define	C16X12R_ROTATION_V_0   0x00
	16x12 R text ASCII byte rotation.
#define	C16X12R_ROTATION_V_180   0x01
#define	C16X12R_ROTATION_H_0   0x10
#define	C16X12R_ROTATION_H_180   0x11
#define	C16X12R_DEVICE_ADDRESS_A2A1_00   0x50
	16x12 R device address setting.
#define	C16X12R_DEVICE_ADDRESS_A2A1_01   0x53
#define	C16X12R_DEVICE_ADDRESS_A2A1_10   0x5C
#define	C16X12R_DEVICE_ADDRESS_A2A1_11   0x5F
#define	C16X12R_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	c16x12r_return_value_t { C16X12R_OK = 0 , C16X12R_ERROR = -1 }
	16x12 R Click return value data. More...

Functions
void	c16x12r_cfg_setup (c16x12r_cfg_t *cfg)
	16x12 R configuration object setup function.
err_t	c16x12r_init (c16x12r_t *ctx, c16x12r_cfg_t *cfg)
	16x12 R initialization function.
err_t	c16x12r_default_cfg (c16x12r_t *ctx)
	16x12 R default configuration function.
err_t	c16x12r_write_reg (c16x12r_t *ctx, uint8_t reg, uint8_t data_in)
	16x12 R write register function.
err_t	c16x12r_write_regs (c16x12r_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
	16x12 R write registers function.
err_t	c16x12r_read_reg (c16x12r_t *ctx, uint8_t reg, uint8_t *data_out)
	16x12 R read register function.
err_t	c16x12r_read_regs (c16x12r_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
	16x12 R read registers function.
void	c16x12r_enable_device (c16x12r_t *ctx)
	16x12 R enable device function.
void	c16x12r_disable_device (c16x12r_t *ctx)
	16x12 R disable device function.
void	c16x12r_reset_device_i2c (c16x12r_t *ctx)
	16x12 R reset device I2C function.
void	c16x12r_set_rst_pin (c16x12r_t *ctx, uint8_t state)
	16x12 R set reset pin state function.
uint8_t	c16x12r_get_intb_pin (c16x12r_t *ctx)
	16x12 R get interrupt pin function.
err_t	c16x12r_lock_page (c16x12r_t *ctx)
	16x12 R lock page function.
err_t	c16x12r_unlock_page (c16x12r_t *ctx)
	16x12 R unlock page function.
err_t	c16x12r_select_page (c16x12r_t *ctx, uint8_t page)
	16x12 R select page function.
err_t	c16x12r_write_page_reg (c16x12r_t *ctx, uint16_t page_reg, uint8_t data_in)
	16x12 R write page register function.
err_t	c16x12r_write_page_regs (c16x12r_t *ctx, uint16_t page_reg, uint8_t *data_in, uint8_t len)
	16x12 R write page registers function.
err_t	c16x12r_read_page_reg (c16x12r_t *ctx, uint16_t page_reg, uint8_t *data_out)
	16x12 R read page register function.
err_t	c16x12r_read_page_regs (c16x12r_t *ctx, uint16_t page_reg, uint8_t *data_out, uint8_t len)
	16x12 R read page registers function.
err_t	c16x12r_fill_screen (c16x12r_t *ctx)
	16x12 R fill screen function.
err_t	c16x12r_clear_screen (c16x12r_t *ctx)
	16x12 R clear screen function.
err_t	c16x12r_set_pwm (c16x12r_t *ctx, uint8_t duty)
	16x12 R set PWM function.
err_t	c16x12r_set_mode (c16x12r_t *ctx, uint8_t mode)
	16x12 R set mode function.
void	c16x12r_set_led_state (c16x12r_t *ctx, uint8_t led_num, uint8_t state)
	16x12 R set LED state function.
err_t	c16x12r_write_leds (c16x12r_t *ctx)
	16x12 R write LEDs function.
err_t	c16x12r_draw_picture (c16x12r_t *ctx, const uint16_t *image)
	16x12 R draw picture function.
err_t	c16x12r_write_char (c16x12r_t *ctx, uint8_t data_in)
	16x12 R write character function.
err_t	c16x12r_write_string (c16x12r_t *ctx, uint8_t *data_in, uint16_t speed_ms)
	16x12 R write string function.

Detailed Description

This file contains API for 16x12 R Click Driver.

Enumeration Type Documentation

c16x12r_return_value_t

enum c16x12r_return_value_t

16x12 R Click return value data.

Predefined enum values for driver return values.

Enumerator
C16X12R_OK
C16X12R_ERROR